home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / HTTPRESPONSE.PY < prev    next >
Encoding:
Python Source  |  2000-09-15  |  14.6 KB  |  400 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. """
  86. ZServer HTTPResponse
  87.  
  88. The HTTPResponse class takes care of server headers, response munging
  89. and logging duties.
  90.  
  91. """
  92. import time, regex, string, sys, tempfile
  93. from cStringIO import StringIO
  94. import thread
  95. from ZPublisher.HTTPResponse import HTTPResponse, end_of_header_search
  96. from medusa.http_date import build_http_date
  97. from PubCore.ZEvent import Wakeup
  98. from medusa.producers import hooked_producer
  99. from medusa import http_server, asyncore
  100. from Producers import ShutdownProducer, LoggingProducer, CallbackProducer, \
  101.     file_part_producer, file_close_producer
  102. from types import LongType
  103. import DebugLogger
  104.  
  105.  
  106. class ZServerHTTPResponse(HTTPResponse):
  107.     "Used to push data into a channel's producer fifo"
  108.  
  109.     # Set this value to 1 if streaming output in
  110.     # HTTP/1.1 should use chunked encoding
  111.     http_chunk=1
  112.     http_chunk_size=1024
  113.     
  114.     # defaults
  115.     _http_version='1.0'
  116.     _http_connection='close'
  117.     _server_version='Zope/2.0 ZServer/2.0'
  118.  
  119.     # using streaming response
  120.     _streaming=0
  121.     # using chunking transfer-encoding
  122.     _chunking=0 
  123.     
  124.     def __str__(self,
  125.                 html_search=regex.compile('<html>',regex.casefold).search,
  126.                 ):        
  127.         if self._wrote:
  128.             if self._chunking:
  129.                 return '0\r\n\r\n'
  130.             else:
  131.                 return ''
  132.  
  133.         headers=self.headers
  134.         body=self.body
  135.         if body:
  136.             isHTML=contHTML=self.isHTML(body)
  137.             if not headers.has_key('content-type'):
  138.                 if isHTML:
  139.                     c='text/html'
  140.                 else:
  141.                     c='text/plain'
  142.                 self.setHeader('content-type',c)
  143.             else:
  144.                 isHTML = string.split(headers.get('content-type', ''),
  145.                                       ';')[0] == 'text/html'
  146.  
  147.             if isHTML and end_of_header_search(self.body) < 0:
  148.                 lhtml=html_search(body)
  149.                 if lhtml >= 0:
  150.                     lhtml=lhtml+6
  151.                     body='%s<head></head>\n%s' % (body[:lhtml],body[lhtml:])
  152.                 elif contHTML:
  153.                     body='<html><head></head>\n' + body
  154.                 else:
  155.                     body='<html><head></head>\n' + body + '\n</html>\n'
  156.                 self.setBody(body)
  157.                 body=self.body
  158.  
  159.         # set 204 (no content) status if 200 and response is empty
  160.         # and not streaming
  161.         if not headers.has_key('content-type') and \
  162.                 not headers.has_key('content-length') and \
  163.                 not self._streaming and \
  164.                 self.status == 200:
  165.             self.setStatus('nocontent')
  166.  
  167.         # add content length if not streaming
  168.         if not headers.has_key('content-length') and \
  169.                 not self._streaming:
  170.             self.setHeader('content-length',len(body))
  171.  
  172.         # ugh - str(content-length) could be a Python long, which will
  173.         # produce a trailing 'L' :( This can go away when we move to
  174.         # Python 2.0...
  175.         content_length= headers.get('content-length', None)
  176.         if type(content_length) is LongType:
  177.             str_rep=str(content_length)
  178.             if str_rep[-1:]=='L':
  179.                 str_rep=str_rep[:-1]
  180.                 self.setHeader('content-length', str_rep)
  181.  
  182.         headersl=[]
  183.         append=headersl.append
  184.      
  185.         status=headers.get('status', '200 OK')
  186.      
  187.         # status header must come first.
  188.         append("HTTP/%s %s" % (self._http_version or '1.0' , status))
  189.         if headers.has_key('status'):
  190.             del headers['status']
  191.         
  192.         # add zserver headers
  193.         append('Server: %s' % self._server_version) 
  194.         append('Date: %s' % build_http_date(time.time()))
  195.  
  196.         if self._http_version=='1.0':
  197.             if self._http_connection=='keep-alive' and \
  198.                     self.headers.has_key('content-length'):
  199.                 self.setHeader('Connection','Keep-Alive')
  200.             else:
  201.                 self.setHeader('Connection','close')
  202.                 
  203.         # Close the connection if we have been asked to.
  204.         # Use chunking if streaming output.
  205.         if self._http_version=='1.1':
  206.             if self._http_connection=='close':
  207.                 self.setHeader('Connection','close')
  208.             elif not self.headers.has_key('content-length'):
  209.                 if self.http_chunk and self._streaming:
  210.                     self.setHeader('Transfer-Encoding','chunked')
  211.                     self._chunking=1
  212.                 else:
  213.                     self.setHeader('Connection','close')                
  214.         
  215.         for key, val in headers.items():
  216.             if string.lower(key)==key:
  217.                 # only change non-literal header names
  218.                 key="%s%s" % (string.upper(key[:1]), key[1:])
  219.                 start=0
  220.                 l=string.find(key,'-',start)
  221.                 while l >= start:
  222.                     key="%s-%s%s" % (key[:l],string.upper(key[l+1:l+2]),key[l+2:])
  223.                     start=l+1
  224.                     l=string.find(key,'-',start)
  225.             append("%s: %s" % (key, val))
  226.         if self.cookies:
  227.             headersl=headersl+self._cookie_list()
  228.         headersl[len(headersl):]=[self.accumulated_headers, body]
  229.         return string.join(headersl,'\r\n')
  230.  
  231.     _tempfile=None
  232.     _templock=None
  233.     _tempstart=0
  234.     
  235.     def write(self,data):
  236.         """\
  237.         Return data as a stream
  238.  
  239.         HTML data may be returned using a stream-oriented interface.
  240.         This allows the browser to display partial results while
  241.         computation of a response to proceed.
  242.  
  243.         The published object should first set any output headers or
  244.         cookies on the response object.
  245.  
  246.         Note that published objects must not generate any errors
  247.         after beginning stream-oriented output. 
  248.  
  249.         """
  250.         stdout=self.stdout
  251.         
  252.         if not self._wrote:
  253.             l=self.headers.get('content-length', None)
  254.             if l is not None:
  255.                 try:
  256.                     if type(l) is type(''): l=string.atoi(l)
  257.                     if l > 128000:
  258.                         self._tempfile=tempfile.TemporaryFile()
  259.                         self._templock=thread.allocate_lock()
  260.                 except: pass
  261.  
  262.             self._streaming=1
  263.             stdout.write(str(self))
  264.             self._wrote=1
  265.  
  266.         if not data: return
  267.  
  268.         if self._chunking:
  269.             data = '%x\r\n%s\r\n' % (len(data),data)
  270.  
  271.         t=self._tempfile
  272.         if t is None:
  273.             stdout.write(data)
  274.         else:
  275.             l=len(data)
  276.             b=self._tempstart
  277.             e=b+l
  278.             self._templock.acquire()
  279.             try:
  280.                 t.seek(b)
  281.                 t.write(data)
  282.             finally:
  283.                 self._templock.release()
  284.             self._tempstart=e
  285.             stdout.write(file_part_producer(t,self._templock,b,e), l)
  286.     
  287.     def _finish(self):
  288.         stdout=self.stdout
  289.  
  290.         t=self._tempfile
  291.         if t is not None:
  292.             stdout.write(file_close_producer(t), 0)
  293.             self._tempfile=None
  294.         
  295.         stdout.finish(self)
  296.         stdout.close()
  297.         
  298.         self.stdout=None # need to break cycle?
  299.         self._request=None
  300.  
  301.  
  302. class ChannelPipe:
  303.     """Experimental pipe from ZPublisher to a ZServer Channel.
  304.     Should only be used by one thread at a time. Note also that
  305.     the channel will be being handled by another thread, thus
  306.     restrict access to channel to the push method only."""
  307.  
  308.     def __init__(self, request):
  309.         self._channel=request.channel
  310.         self._request=request
  311.         self._shutdown=0
  312.         self._close=0
  313.         self._bytes=0
  314.     
  315.     def write(self, text, l=None):
  316.         if self._channel.closed:
  317.             return
  318.         if l is None: l=len(text)
  319.         self._bytes=self._bytes + l
  320.         self._channel.push(text,0)
  321.         Wakeup()
  322.         
  323.     def close(self):
  324.         DebugLogger.log('A', id(self._request), 
  325.                 '%s %s' % (self._request.reply_code, self._bytes))
  326.         if not self._channel.closed:
  327.             self._channel.push(LoggingProducer(self._request, self._bytes), 0)
  328.             self._channel.push(CallbackProducer(self._channel.done), 0)
  329.             self._channel.push(CallbackProducer(
  330.                 lambda t=('E', id(self._request)): apply(DebugLogger.log, t)), 0)
  331.             if self._shutdown:
  332.                 try: r=self._shutdown[0]
  333.                 except: r=0
  334.                 sys.ZServerExitCode=r
  335.                 self._channel.push(ShutdownProducer(), 0)
  336.                 Wakeup()
  337.             else:
  338.                 if self._close: self._channel.push(None, 0)
  339.             Wakeup()
  340.         else:
  341.             # channel closed too soon
  342.  
  343.             self._request.log(self._bytes)
  344.             DebugLogger.log('E', id(self._request))
  345.  
  346.             if self._shutdown:
  347.                 try: r=self._shutdown[0]
  348.                 except: r=0
  349.                 sys.ZServerExitCode=r
  350.                 Wakeup(lambda: asyncore.close_all())
  351.             else:
  352.                 Wakeup()
  353.  
  354.         self._channel=None #need to break cycles?
  355.         self._request=None
  356.  
  357.     def flush(self): pass # yeah, whatever
  358.     
  359.     def finish(self, response):
  360.         if response.headers.get('bobo-exception-type', '') == \
  361.                 'exceptions.SystemExit':
  362.  
  363.             r=response.headers.get('bobo-exception-value','0')
  364.             try: r=string.atoi(r)
  365.             except: r = r and 1 or 0
  366.             self._shutdown=r,
  367.         if response.headers.get('connection','') == 'close' or \
  368.                 response.headers.get('Connection','') == 'close':
  369.             self._close=1
  370.         self._request.reply_code=response.status
  371.         
  372.     def retry(self):
  373.         """Return a request object to be used in a retry attempt
  374.         """
  375.         
  376.         # This implementation is a bit lame, because it assumes that
  377.         # only stdout stderr were passed to the constructor. OTOH, I
  378.         # think that that's all that is ever passed.
  379.  
  380.         response=self.__class__(stdout=self.stdout, stderr=self.stderr)
  381.         response._http_version=self._http_version
  382.         response._http_connection=self._http_connection
  383.         response._server_version=self._server_version
  384.         return response
  385.         
  386.     
  387.         
  388. def make_response(request, headers):
  389.     "Simple http response factory"
  390.     # should this be integrated into the HTTPResponse constructor?
  391.     
  392.     response=ZServerHTTPResponse(stdout=ChannelPipe(request), stderr=StringIO())
  393.     response._http_version=request.version
  394.     response._http_connection=string.lower(
  395.             http_server.get_header(http_server.CONNECTION, request.header))
  396.     response._server_version=request.channel.server.SERVER_IDENT
  397.     return response
  398.     
  399.  
  400.